home *** CD-ROM | disk | FTP | other *** search
/ STraTOS 1997 April & May / STraTOS 1 - 1997 April & May.iso / CD01 / INTERNET / SITES / GRAHAM / XAAES_S.ZIP / XAAES / DOCS / USERGUID.BAK < prev    next >
Encoding:
Text File  |  1996-04-01  |  5.4 KB  |  152 lines
  1. XaAES User Manual
  2. (W)Craig Graham (c_graham@patrol.i-way.co.uk)
  3.  
  4. 1) INSTALLATION
  5. -------------------
  6.  
  7. Installing is pretty easy, just do the following:
  8.  
  9. i) Stick these files all in one directroy:
  10.    xaaes.tos   - The kernal (colour & mono versions are in seperate archives)
  11.    xaaes.cnf   - Like GEM.CNF, but for xaaes.
  12.    mousserv.tos   - the mouse handler
  13.    logo.prg - the XaAES logo, (possibly) launched at startup.
  14.    system.rsc  - various GUI elements for the kernal (default menu, alert template, etc)
  15.    sys\toswin_w.tos  - The usual toswin console.
  16.    sys\TOSWIN.RSC    - resource file for the above.
  17.    sys\rt.tos  - runtos
  18.  
  19. ii) If you want a console shell (the xaaes.cnf file is set up to give you one),
  20.    you should edit the xaaes.cnf file so rt runs your fave shell (I use sh, but
  21.    mupfel, etc will work as well).
  22.  
  23. iii) Add these lines to your MiNT.CNF file:
  24.  
  25.       cd u:\<path>
  26.       INIT=u:\<path>\xaaes.tos
  27.  
  28.      Alternatively, if you are a bit more of a techie, XaAES will run happily from
  29.      a command line (and let you exit back to it) or as a login shell.
  30.  
  31. Ok, thats it.
  32.  
  33. 1.1) COMMAND LINE ARGUMENTS
  34.  
  35. XaAES only has one command line switch, which sets the video mode for falcon users:
  36.  
  37.          -video <mode>
  38.  
  39. where <mode> is:
  40.  
  41.       0 = 80 column, non-interlace, mono
  42.       1 = 80 column, non-interlace, 4 colour
  43.       2 = 80 column, non-interlace, 16 colour
  44.       3 = 80 column, non-interlace, 256 colour
  45.  
  46. These don't work very well at the moment, but do get round the NVDI2.5 problem.
  47. If you are using NVDI on a falcon, and you get a black screen on starup, try
  48. starting XaAES with the '-video 2' as a parameter (this should sort you out).
  49.  
  50. NOTE: If you are using an ST with a colour monitor/TV, holding down either shift
  51. key whilst XaAES loads will select medium rez instead of low.
  52.  
  53. 2) Using XaAES
  54. -----------------
  55.  
  56. 2.1) Menus
  57.  
  58. Generally XaAES is like GEM, but with a few exceptions. Most notably, menu's are
  59. Mac-style pull down, not GEM style drop down. This means that you've got to click
  60. on a menu title to see the menu, not just point at it.
  61.  
  62. 2.2) Typing
  63.  
  64. XaAES is point-to-type - so keyboard input goes to the window under the mouse and
  65. NOT to the top window. (This depends on compile time flags - check the boot message
  66. to see if this feature is active).
  67.  
  68.  
  69. 3) XaAES Keyboard Combo's
  70. ----------------------------
  71.  
  72. There are a couple of keyboard combo's that XaAES uses for itself. These are:
  73.  
  74. CTRL+ALT+TAB     : swaps menu bars, not top windows.
  75. CTRL+ALT+L       : Output a list of current client programs to the debug file
  76. CTRL+ALT+D       : Output a status dump to the debug file
  77. CTRL+ALT+K       : Clean up - search for dead clients that didn't call appl_exit
  78. CTRL+ALT+R       : Attempt to recover control of a hung system - use as a last resort,
  79.                    as this will kill the clients that are blocking the system.
  80.  
  81. NOTE: CTRL+ALT+L & CTRL+ALT+D only output anything if GENERATE_DIAGS was turned on at
  82. compile time - in the binary distributions released by me (Craig) they will have no
  83. effect as all diagnostics are turned off.
  84.  
  85. 4) SYSTEM MENU
  86. ---------------
  87.  
  88. The XaAES system menu (CTRL+ALT+TAB until you get it) currently contains two useful
  89. options.
  90.  
  91. One is the 'About XaAES...' option which (surprisingly) brings up a nice
  92. little descriptive box.
  93.  
  94. The other (more useful) option is in 'Shutdown'. This will kill all GEM programs
  95. and exit XaAES gracefully. Unlike MultiTOS, if you ran XaAES from a command line
  96. or as a login shell, you will be returned to the command line or login prompt. You
  97. can then re-start XaAES, or do whatever - XaAES can be exitted and restarted as many
  98. times as you like without rebooting the machine.
  99.  
  100. XaAES catches CTRL+ALT+C and CTRL+ALT+\  (SIGINT & SIGQUIT respectively) and executes
  101. the shutdown procedure in response to them, so you should be able to get back to your
  102. command line in most situations.
  103.  
  104. 5) THE xaaes.cnf FILE
  105. -----------------------
  106.  
  107. This is a bit like MultiTOS's GEM.CNF file. It's main purpose is to let you auto-launch
  108. programs as XaAES starts up. Generally the syntax of this is supposed to be the same as
  109. Atari's GEM.CNF file
  110.  
  111. It's a simple text file with the following format:
  112.  
  113. i)   '#' is a comment line.
  114. ii)  Commands are not case sensitive (although paths may be, depending on your filesystem).
  115. iii) If a command isn't understood, it gets ignored...
  116. iv)  These commands are currently supported:
  117.  
  118.          run <program> <parameters....>
  119.             Launch a program.
  120.  
  121.          debug <file/device>
  122.             Set debugging output to <file/device> (default is .\debug.list)
  123.  
  124.          clipboard <directory>
  125.             Set the GEM clipboard to be in <directory> (default is c:\clipbrd).
  126.  
  127. And example xaaes.cnf file (in fact, the one I use) is:
  128.  
  129.    #Craig's Setup
  130.    #---------------
  131.    # Set the default clipboard path
  132.    clipboard c:\clipbrd\
  133.    #
  134.    # Launch toswin (68030 version) to handle TOS programs for me
  135.    run u:\h\sources\aes\sys\toswin30.prg
  136.    #
  137.    # Launch the desktop
  138.    run u:\c\thing\thing.app
  139.    #
  140.    # Set Debugging to go to serial port
  141.    debug u:\dev\ttyb
  142.    #
  143.  
  144. x) Caveats
  145. --------------
  146.  
  147. I've compiled  out most of the diagnostics, but if you get funny messages on
  148. the screen, add the line 'debug \dev\null' to the xaaes.cnf file.
  149.  
  150. Loads of stuff is missing at the moment, don't hassle me - fix it and get back
  151. to me.
  152.